package com.zdpx.pxframework.system.api;

import com.zdpx.pxframework.core.vo.PageResult;
import com.zdpx.pxframework.core.vo.Result;
import com.zdpx.pxframework.system.entity.PostInfo;
import com.zdpx.pxframework.system.vo.query.PostInfoQuery;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;

import java.util.List;


/**
 * 岗位 接口Swagger Api
 *
 * @Description:
 * @Author: Cheng XiaoXiao
 * @Date: 2022-02-27 15:20:14
 */
@Api(tags = "岗位模块", description = "实现对岗位数据的基本操作")
public interface PostInfoControllerApi {


    /**
     * 按照条件查询岗位信息
     *
     * @param postInfoQuery 查询条件
     * @return 结果信息
     */
    @ApiOperation(value = "按照条件查询岗位信息")
    Result<List<PostInfo>> list(PostInfoQuery postInfoQuery);

    /**
     * 分页及条件查询岗位信息
     *
     * @param page          页码
     * @param size          分页大小
     * @param postInfoQuery 查询条件
     * @return 分页结果信息
     */
    @ApiOperation(value = "分页及条件查询岗位信息")
    Result<PageResult<PostInfo>> search(@ApiParam(name = "page", value = "当前页", required = true, type = "path") Long page,
                                        @ApiParam(name = "size", value = "页码大小", required = true, type = "path") Long size,
                                        PostInfoQuery postInfoQuery);

    /**
     * 根据ID获取岗位详情
     *
     * @param id 岗位ID
     * @return 岗位详细信息
     */
    @ApiOperation(value = "获取单个岗位详情")
    @ApiParam(name = "id", value = "岗位ID", required = true, type = "path")
    Result<PostInfo> detail(String id);

    /**
     * 增加岗位信息
     *
     * @param postInfo 岗位增加实体
     * @return 增加后的岗位信息
     */
    @ApiOperation(value = "增加岗位信息")
    Result<PostInfo> add(PostInfo postInfo);

    /**
     * 修改岗位信息
     *
     * @param id       岗位ID
     * @param postInfo 岗位修改实体
     * @return 修改后的岗位信息
     */
    @ApiOperation(value = "修改岗位信息")
    Result<PostInfo> updateById(@ApiParam(name = "id", value = "岗位ID", type = "path") String id, PostInfo postInfo);

    /**
     * 删除岗位信息
     *
     * @param id 岗位ID
     * @return 删除结果信息
     */
    @ApiOperation(value = "删除单个岗位信息")
    Result<Boolean> deleteById(@ApiParam(name = "id", value = "岗位ID", type = "path") String id);

    /**
     * 删除岗位信息
     *
     * @param idList 岗位ID数组
     * @return 删除结果信息
     */
    @ApiOperation(value = "批量删除岗位信息")
    Result<Boolean> batchRemove(List<String> idList);

}
